/*
 * Copyright (c) OSGi Alliance (2005). All Rights Reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this
 * distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.
 *
 * This copyright applies to the comments and public final static String fields only
 */
package com.winnemconsulting.javatoactionscript.exception.runtimeexception
{

	/**
	 * A Framework exception.
	 *
	 * <p>
	 * An <code>InvalidSyntaxException</code> object indicates that a filter
	 * string parameter has an invalid syntax and cannot be parsed.
	 *
	 * <p>
	 * See {@link Filter} for a description of the filter string syntax.
	 *
	 * @version $Revision: 1.14 $
	 */

	public class InvalidSyntaxException extends Error
	{
		private static var serialVersionUID:Number=-4295194420816491875;
		/**
		 * The invalid filter string.
		 */
		private var filter:String;
		/**
		 * Nested exception.
		 */
		private var cause:Object;

		/**
		 * Creates an exception of type <code>InvalidSyntaxException</code>.
		 *
		 * <p>
		 * This method creates an <code>InvalidSyntaxException</code> object with
		 * the specified message and the filter string which generated the
		 * exception.
		 *
		 * @param msg The message.
		 * @param filter The invalid filter string.
		 * @param cause The cause of this exception.
		 * @since 1.3
		 */
		public function InvalidSyntaxException(msg:String, filter:String, cause:Object=null)
		{
			super(msg);
			this.filter=filter;
			this.cause=cause;
		}

		/**
		 * Returns the filter string that generated the
		 * <code>InvalidSyntaxException</code> object.
		 *
		 * @return The invalid filter string.
		 * @see BundleContext#getServiceReferences
		 * @see BundleContext#addServiceListener(ServiceListener,String)
		 */
		public function getFilter():String
		{
			return filter;
		}

		/**
		 * Returns the cause of this exception or <code>null</code> if no cause
		 * was specified when this exception was created.
		 *
		 * @return The cause of this exception or <code>null</code> if no cause
		 *         was specified.
		 * @since 1.3
		 */
		public function getCause():Object
		{
			return cause;
		}

		/**
		 * The cause of this exception can only be set when constructed.
		 *
		 * @param cause Cause of the exception.
		 * @return This object.
		 * @throws java.lang.IllegalStateException This method will always throw an
		 *         <code>IllegalStateException</code> since the cause of this
		 *         exception can only be set when constructed.
		 * @since 1.3
		 */
		public function initCause(cause:Object):Object
		{
			throw new IllegalStateException();
		}
	}
}